Skip to main content
开始任务请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteTaskCommandType": "START_TASK",
"commandParameter": {
"startTaskParameter": {
"cleaningMode": "__middle_cleaning",
"task": {
"loop": false,
"loopCount": 1,
"map": "9-2",
"name": "execute_task_a_a_path0"
}
}
}
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/01822cd9-91e3-44f5-905e-24c524311059",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {
"startTaskParameter": {
"cleaningMode": "__middle_cleaning",
"task": {
"name": "execute_task_a_a_path0",
"map": "9-2",
"subTasks": [],
"loop": false,
"loopCount": 1
}
}
},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T03:22:11.445077728Z",
"updateTime": "2024-09-03T03:22:11.445077963Z",
"startTime": "2024-09-03T03:22:11.444Z",
"startDelay": 1800000,
"rawCommandType": "start_task"
}
暂停任务请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteTaskCommandType": "PAUSE_TASK"
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/0ae8fea7-2767-4377-a8db-7f84be510adc",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T03:30:27.139898925Z",
"updateTime": "2024-09-03T03:30:27.139899148Z",
"startTime": "2024-09-03T03:30:27.139Z",
"startDelay": 1800000,
"rawCommandType": "pause_task"
}
恢复任务请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteTaskCommandType": "RESUME_TASK"
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/9882d7ec-96f7-439d-8864-311288023673",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T03:27:23.384654972Z",
"updateTime": "2024-09-03T03:27:23.384655266Z",
"startTime": "2024-09-03T03:27:23.374Z",
"startDelay": 1800000,
"rawCommandType": "resume_task"
}
停止任务请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteTaskCommandType": "STOP_TASK"
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/74935065-f5d5-48f8-9f35-975fbf56ef48",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T03:31:32.703416444Z",
"updateTime": "2024-09-03T03:31:32.703416696Z",
"startTime": "2024-09-03T03:31:32.703Z",
"startDelay": 1800000,
"rawCommandType": "stop_task"
}
导航到点请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteNavigationCommandType": "CROSS_NAVIGATE",
"commandParameter": {
"startNavigationParameter": {
"map": "9-2",
"position": "Cd"
}
}
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/460c9c91-5d4a-44a4-838b-e84b2f372e16",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {
"startNavigationParameter": {
"map": "9-2",
"position": "Cd"
}
},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T03:40:11.090711961Z",
"updateTime": "2024-09-03T03:40:11.090712246Z",
"startTime": "2024-09-03T03:40:11.090Z",
"startDelay": 1800000,
"rawCommandType": "cross_navigate"
}
暂停导航到点请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{

"serialNumber": "TEST00-0000-000-S003",
"remoteNavigationCommandType": "PAUSE_NAVIGATE",
"commandParameter": {
"startNavigationParameter": {
"map": "9-2",
"position": "Cd"
}
}
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/52daecd7-191e-4cc7-99b4-7076ab6ee34f",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {
"startNavigationParameter": {
"map": "9-2",
"position": "Cd"
}
},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T03:43:32.479936302Z",
"updateTime": "2024-09-03T03:43:32.479936661Z",
"startTime": "2024-09-03T03:43:32.479Z",
"startDelay": 1800000,
"rawCommandType": "pause_navigate"
}
恢复导航到点请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteNavigationCommandType": "RESUME_NAVIGATE",
"commandParameter": {
"startNavigationParameter": {
"map": "9-2",
"position": "Cd"
}
}
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/604b2408-c977-427e-8f42-95255605f33c",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {
"startNavigationParameter": {
"map": "9-2",
"position": "Cd"
}
},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T03:44:30.566078835Z",
"updateTime": "2024-09-03T03:44:30.566079251Z",
"startTime": "2024-09-03T03:44:30.565Z",
"startDelay": 1800000,
"rawCommandType": "resume_navigate"
}
停止导航到点请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{

"serialNumber": "TEST00-0000-000-S003",
"remoteNavigationCommandType": "STOP_NAVIGATE",
"commandParameter": {
"startNavigationParameter": {
"map": "9-2",
"position": "Cd"
}
}

}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/c15d659e-436e-49ea-84d0-d836c3259d65",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {
"startNavigationParameter": {
"map": "9-2",
"position": "Cd"
}
},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T03:45:04.531310021Z",
"updateTime": "2024-09-03T03:45:04.531310280Z",
"startTime": "2024-09-03T03:45:04.531Z",
"startDelay": 1800000,
"rawCommandType": "stop_navigate"
}
开启远程控制服务请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteControlCommandType": "REMOTE_CONTROL_START"
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/76ec43ad-88d7-4ccd-8840-298897fb3fdb",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T06:18:52.882270220Z",
"updateTime": "2024-09-03T06:18:52.882270426Z",
"startTime": "2024-09-03T06:18:52.882Z",
"startDelay": 1800000,
"rawCommandType": "remote_control_start"
}
远程控制移动请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteControlCommandType": "REMOTE_CONTROL_MOVE",
"commandParameter": {
"controlMovingParameter": {
"direction": "FORWARD"
}
}
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/544ff0c1-90fd-4156-a56d-ed0ad37f7f6e",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {
"controlMovingParameter": {
"direction": "forward"
}
},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T06:20:23.044801552Z",
"updateTime": "2024-09-03T06:20:23.044801809Z",
"startTime": "2024-09-03T06:20:23.044Z",
"startDelay": 1800000,
"rawCommandType": "remote_control_move"
}
停止远程控制功能请求

curl --location 'https://openapi.gs-robot.com/v1alpha1/robots/TEST00-0000-000-S003/commands'
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {{token}}'
--data '{
"serialNumber": "TEST00-0000-000-S003",
"remoteControlCommandType": "REMOTE_CONTROL_STOP"
}'
输出

{
"name": "robots/TEST00-0000-000-S003/commands/0ea51a86-6d03-45f3-bac0-ba5513570f19",
"parent": "robots/TEST00-0000-000-S003",
"commandParameter": {},
"state": "WAITING",
"serialNumber": "TEST00-0000-000-S003",
"user": "14f7bce578e0c2d0e04962bdd611f577",
"createTime": "2024-09-03T06:21:47.821634697Z",
"updateTime": "2024-09-03T06:21:47.821634950Z",
"startTime": "2024-09-03T06:21:47.821Z",
"startDelay": 1800000,
"rawCommandType": "remote_control_stop"
}